iT邦幫忙

2024 iThome 鐵人賽

DAY 1
1
IT 管理

30天從版控到code review的實踐指南系列 第 1

Day 1. 簡介與摘要:從版控流程到程式碼管理。

  • 分享至 

  • xImage
  •  

內容簡介


在多人協作的系統專案中,程式碼版本控管是一個至關重要的流程,良好的版控規劃能夠有效地管理各個開發者的工作成果,並確保程式碼的整合與穩定性。隨著專案規模增長,如何高效地協作與管理程式碼變得更加關鍵。而其中,併版過程中的 Code Review 更是不可或缺的一環,透過它不僅能確保程式碼品質,還可以避免潛在問題的發生,提升團隊開發的效率。

在這三十天的系列文章中,將探討程式碼版本控管與Code Review的實踐。首先,會從Git Flow、GitLab Flow、GitHub Flow這三種常見的版本控管流程入手,逐步介紹如何透過這些流程管理分支與版本。接著,將會探討Pull Request (PR) 的細節,從撰寫commit規則到發佈PR範本,如何解決合併衝突,再到最終的release版號管理與自動化發布流程。這段過程將結合GitHub Actions,展示如何透過自動化工具優化專案管理。

最後,將介紹Code Review的原則與流程,分享如何檢查程式碼的功能邏輯、風格一致性、效能與安全性。其中,也會介紹一些輔助檢查工具,如ESLint與Prettier,確保程式碼在開發過程中的高品質與可維護性。

每日主題


  • 版控流程。
    day 2:git flow。
    day 3:gitlab flow。
    day 4:github flow。
    day 5:實作版控流程圖;分支命名原則。
    day 6:總結-導入遇到的困難與注意事項提醒。

  • Pull Request細節;release版本號。
    day 7:Commit規則。
    day 8:Pull Request範本;解conflicts原則。
    day 9:介紹、實作issue。
    day 10:手動加tag與指令示範。
    day 11-12:實作自動化加release版號-GitHub Actions。
    day 13:總結-導入遇到的困難與注意事項提醒。

  • Code Review。
    day 14:Clean Code-易讀性、可維護性、團隊效率。
    day 15:Code Review 檢查原則-功能邏輯、程式碼風格、效能、可維護性與易讀性、安全性、模組化與重用性。
    day 16-17:功能邏輯rules。
    day 18-21:程式碼風格rules;實作ESLint;實作Prettier。
    day 22-24:可維護性與易讀性rules;套件輔助閱讀(IDE: vs code/ vs)。
    day 25-26:安全性rules(XSS)。
    day 27-28:模組化與重用性rules。

  • 零星補充;回顧;Summary。
    day 29:補充與回顧。
    day 30:Summary。

下一篇
Day 2. 版控流程介紹:Git Flow。
系列文
30天從版控到code review的實踐指南30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

1 則留言

0
JYHsu
iT邦新手 3 級 ‧ 2024-09-29 15:27:00

必須推 /images/emoticon/emoticon31.gif

我要留言

立即登入留言